/**
 * @apiDefine stock 库存
 * @apiHeader {String} token 用户登录获取的token
 */


/**
 * @api {POST} /stock/goods_list 库存列表
 * @apiSampleRequest /stock/goods_list
 * @apiDescription <h3>获取列表：</h3>
 * <ol>
 *     <li>默认status=0，获取当前收银员未提交的商品列表</li>
 *     <li>status=1并且给定order_id，获取已提交，但未入库的商品列表</li>
 *     <li>status=100并且给定order_id，获取已入库的商品列表</li>
 * </ol>
 * @apiGroup stock
 * @apiUse stock
 * @apiParam {Number} [goods_id=None] 商品ID
 * @apiParam {Number} [order_id=None] 入库单ID
 * @apiParam {Number} [status=0] 入库单状态 0未入库，1已提交（未累加到商品库存），100已入库
 * @apiParam {Number} [page=1] 分页
 * @apiParam {Number} [size=15] 数量
 * @apiSuccess {Object} /data 数据
 * @apiSuccessExample {json} 成功响应：
 * HTTP/1.1 200 OK
 * {
 *     "errcode": 0,
 *     "data": [
 *         {
 *             "id": 6, // 商品库存ID
 *             "order_id": 0, // 入库ID
 *             "shop_id": 1, // 店铺ID
 *             "cashier_id": 3, // 收银员ID
 *             "goods_id": 145, // 商品ID
 *             "cost_price": "10.20", // 成本价
 *             "amount": 2, // 入库数量
 *             "subtotal": "20.40", // 小计
 *             "status": 0, // 状态
 *             "created": 1634028389,
 *             "updated": 1634042245,
 *             "class_id": 2, // 商品分类
 *             "goods_name": "大鸭梨", // 商品名称
 *             "scount": 957, // 库存数量
 *             "is_ban": 0, // 0 上架 1 下架
 *             "create_time": "2021-09-23T11:15:02", // 创建时间
 *             "state": 1, // 审核状态，0：审核中，1审核通过，2：审核拒绝
 *             "discount_ratio": null, // 商品折扣比例
 *             "is_community": 1, // 是否是社区超市商品 0 否 1 是
 *             "is_warehouse": 1, // 是否是仓储商品 0 否 1 是
 *             "point_ratio": null, // 积分比例、会员比例
 *             "barcode": "", // 条形码
 *             "unit": "", // 单位
 *             "guardian_ratio": 0.16, // 守护者获得购物券比例
 *             "product_date": null, // 生产日期
 *             "guarantee_period": null, // 保质期
 *             "guarantee_type": null, // 保质期类型 1 日 2 月 3 年
 *             "goods_img": "xxx.png" // 商品图片
 *         }
 *     ],
 *     "total": 2, // 款数/入库商品数
 *     "page": 1,
 *     "size": 15
 *     "total_amount": "2", // 总件数
 *     "total_price": "10.00" // 总价
 * }
 */


/**
 * @api {POST} /stock/add_goods 添加入库商品【弃】
 * @apiSampleRequest /stock/add_goods
 * @apiGroup stock
 * @apiUse stock
 * @apiParam {Number} goods_id 商品ID
 * @apiParam {Number} [amount=None] 入库数量
 * @apiSuccess {Object} /data 数据
 * @apiSuccessExample {json} 成功响应：
 * HTTP/1.1 200 OK
 * {
 *     "errcode": 0,
 *     "data": {
 *         "stock_id": 6, // 库存ID
 *         "opt_typ": "update",  // 操作类型 add添加、update更新、del删除
 *         "amount": 8, // 入库数量
 *         "subtotal": "81.60", // 小计
 *         "cost_price": "10.20" // 成本价
 *     }
 * }
 */


/**
 * @api {POST} /stock/update_goods 添加、更新、删除入库信息
 * @apiSampleRequest /stock/update_goods
 * @apiGroup stock
 * @apiUse stock
 * @apiParam {Number} goods_id 商品ID
 * @apiParam {Number} [amount=None] 入库数量
 * @apiDescription <h3>更新包括以下情况：</h3>
 * <ol>
 *     <li>amount=-1或不存在，商品库存累加</li>
 *     <li>amount>0，更新商品库存数量</li>
 *     <li>amount=0，商品从库存中删除</li>
 * </ol>
 * @apiSuccess {Object} /data 数据
 * @apiSuccessExample {json} 成功响应：
 * HTTP/1.1 200 OK
 * {
 *     "errcode": 0,
 *     "data": {
 *         "stock_id": 6, // 库存ID
 *         "opt_typ": "update",  // 操作类型 add添加、update更新、del删除
 *         "amount": 8, // 入库数量
 *         "subtotal": "81.60", // 小计
 *         "cost_price": "10.20" // 成本价
 *     }
 * }
 */


/**
 * @api {POST} /stock/submit_order 提交入库单
 * @apiSampleRequest /stock/submit_order
 * @apiGroup stock
 * @apiUse stock
 * @apiParam {String} remark 入库单备注
 * @apiParam {String} amount_paid 支付金额
 * @apiSuccess {Object} /data 数据
 * @apiSuccessExample {json} 成功响应：
 * HTTP/1.1 200 OK
 * {
 *     "errcode": 0
 * }
 */


/**
 * @api {POST} /stock/confirm_order 确认入库单、直接入库
 * @apiSampleRequest /stock/confirm_order
 * @apiDescription <p>直接入库，不需要传入id，选填参数备注和支付金额。</p>
 *  <p>确认入库单，需要传入id，不需要传入备注和支付金额。</p>
 * @apiGroup stock
 * @apiUse stock
 * @apiParam {Number} [id=0] 入库单ID
 * @apiParam {String} [remark] 入库单备注
 * @apiParam {String} [amount_paid] 支付金额
 * @apiSuccess {Object} /data 数据
 * @apiSuccessExample {json} 成功响应：
 * HTTP/1.1 200 OK
 * {
 *     "errcode": 0
 * }
 */
